GET api/trips/cancelled?startDate={startDate}&endDate={endDate}&serviceTypeIds[0]={serviceTypeIds[0]}&serviceTypeIds[1]={serviceTypeIds[1]}
Gets trips that have been cancelled
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
startDate |
Get trips that occur on or after this date |
date |
None. |
endDate |
Get trips that occur on or before this date |
date |
None. |
serviceTypeIds |
Get trips with any of these service type ids. Don't filter by service type id if no ids are included |
Collection of integer |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of BookingStatusName | Description | Type | Additional information |
---|---|---|---|
BookingId |
The booking |
integer |
None. |
ClientId |
The client that the booking is for |
integer |
None. |
Status |
The status |
TripStatus |
None. |
ServiceTypeId |
The booking's service type |
integer |
None. |
Response Formats
application/json, text/json
Sample:
[ { "bookingId": 1, "clientId": 2, "status": { "status": 0, "internalCode": "sample string 1", "notes": "sample string 2" }, "serviceTypeId": 1 }, { "bookingId": 1, "clientId": 2, "status": { "status": 0, "internalCode": "sample string 1", "notes": "sample string 2" }, "serviceTypeId": 1 } ]
application/xml, text/xml
Sample:
<ArrayOfBookingStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources"> <BookingStatus> <BookingId>1</BookingId> <ClientId>2</ClientId> <ServiceTypeId>1</ServiceTypeId> <Status> <InternalCode>sample string 1</InternalCode> <Notes>sample string 2</Notes> <Status>Unscheduled</Status> </Status> </BookingStatus> <BookingStatus> <BookingId>1</BookingId> <ClientId>2</ClientId> <ServiceTypeId>1</ServiceTypeId> <Status> <InternalCode>sample string 1</InternalCode> <Notes>sample string 2</Notes> <Status>Unscheduled</Status> </Status> </BookingStatus> </ArrayOfBookingStatus>